home *** CD-ROM | disk | FTP | other *** search
/ PC Joker 2000 December / PCJ1200CD2.ISO / PATCHES / Heavy Metal FAKK 2 / editingreadme.txt next >
Encoding:
Text File  |  2000-09-17  |  8.0 KB  |  166 lines
  1. Please do not email Ritual Entertainment with questions about the tools or the
  2. source, we do not have the resources to support the source or the utilities.
  3. They are provided as is, and are meant for the hardcore hackers out there.
  4.  
  5. Revision History
  6. ================
  7. 09/17/2000 - Not all the tools properly supported the FTX format.  Tools were
  8. updated so that FTX files would not have to be re-converted back into TGA
  9. files for the tools proper use.
  10. 09/15/2000 - Initial Release
  11.  
  12. Heavy Metal FAKK 2 TOOLS ( Veraion 1.02 )- 09/15/2000
  13.  
  14. license.rtf             - the license file
  15. readme.txt              - what you are reading
  16.  
  17. bin\dlgedit.exe         - the resource building utility
  18. bin\fontgen.exe         - Windows font converter utility
  19. bin\ftxconvert.exe      - Converts FTX files back into TGA
  20. bin\lipsync.exe         - generates lipsync data for wav's or mp3's
  21. bin\lw2tan.exe          - Lightwave to tan converter
  22. bin\max2skl.exe         - 3D Studio MAX 3.0 to SKL converter
  23. bin\max2tan.exe         - 3D Studio MAX 3.0 to TAN converter
  24. bin\mcopy.exe           - Handy script based copy program
  25. bin\newq3map.exe        - Map building tool using new Vis algorithm
  26. bin\q3map.exe           - Map building tool
  27. bin\q3radiant.exe       - Map Editor
  28. bin\radiant.ini         - INI file for Q3Radiant
  29. bin\runq3radiant.bat    - Batch file to run Q3Radiant
  30. bin\tgaconvert.exe      - Coverts TGA files into FTX files
  31. bin\max2plugins\animout.dle - 3D Studio MAX 2.0 ANM exporter
  32. bin\max2plugins\skelout.dle - 3D Studio MAX 2.0 SKL exporter
  33. bin\max2plugins\uvout.dle   - 3D Studio MAX 2.0 UV exporter
  34. bin\max3plugins\animout.dle - 3D Studio MAX 3.0 ANM exporter
  35. bin\max3plugins\skelout.dle - 3D Studio MAX 3.0 SKL exporter
  36. bin\max3plugins\uvout.dle   - 3D Studio MAX 3.0 UV exporter
  37. bin\maxscripts\example.ms   - example MaxScript
  38. bin\maxscripts\exportskl.ms - MaxScript functions
  39. bin\maxscripts\jimtest.ms   - another MaxScript example
  40. bin\Radiant plugins\Fakk2Plug.dll - Q3Radiant plugin in for FAKK 2
  41.  
  42. docs\AI.doc             - AI overview
  43. docs\camera documentation.doc   - Camera system overview
  44. docs\Client Side Commands.doc   - Client side (cgame) command overview
  45. docs\commands.txt               - preliminary cmdlist documentation
  46. docs\Coordinate System.doc      - Coordinate systems used in FAKK 2
  47. docs\CVAR DOCUMENTATION.doc     - Extensive CVAR documentation
  48. docs\Description of Menus and Ingame Utils.doc - In game tools overview
  49. docs\Dialog System.doc          - Dialog system overview
  50. docs\Dumping Demo AVI.doc       - Dumping demos to AVI format overview
  51. docs\Event Spec Documentation.doc - How to document new Events
  52. docs\FAKK FAQ.doc               - general q/a on FAKK 2 development
  53. docs\Ghost Particle System.doc  - Particle system overview
  54. docs\Gibs.doc                   - How to add gibs to characters
  55. docs\GUI Documentation.doc      - GUI system overview
  56. docs\How to Make Weapons and Ammo.doc - how to make weapons and ammo
  57. docs\Inventory System Commands.doc - Inventory system overview
  58. docs\Items.doc                  - items in Fakk 2
  59. docs\MAX2SKL Reference Guide.doc - MAX2SKL reference
  60. docs\Radiant Commands.doc       - Radiant documentation
  61. docs\shader_manual_new.doc      - Shader Manual
  62. docs\Sound System.doc           - Sound system overview
  63. docs\TIKI Model System.doc      - TIKI system overview
  64. docs\Tiki QuakeEd Specs.doc     - QUAKED specification for TIKI models
  65.  
  66. entities\entities.def           - combined QUAKED headers for Q3RADIANT
  67.  
  68. fakk\maps\example\autocamera.bsp - demonstrates use of autocameras
  69. fakk\maps\example\autosprite.bsp - demonstrates use of autosprites
  70. fakk\maps\example\beam.bsp      - demonstrates use of beams
  71. fakk\maps\example\beam1.bsp     - demonstrates use of beams
  72. fakk\maps\example\box3.bsp      - simple map
  73. fakk\maps\example\CameraScript.bsp - demonstrates use of Scripted Cameras
  74. fakk\maps\example\climb.bsp     - demonstrates climbing on walls and ropes
  75. fakk\maps\example\cover.bsp     - demonstrates AI Cover
  76. fakk\maps\example\door.bsp      - demonstrates different doors
  77. fakk\maps\example\doors.bsp     - demonstartes more doors
  78. fakk\maps\example\earthquake.bsp - earthquake demonstration
  79. fakk\maps\example\explodeobject.bsp - exploding object demonstration
  80. fakk\maps\example\exploder.bsp  - exploder demonstration
  81. fakk\maps\example\explodingwall.bsp - explodingwall demonstration
  82. fakk\maps\example\fallingrock.bsp - falling rock demonstration
  83. fakk\maps\example\fulcrum.bsp   - fulcrum demonstration
  84. fakk\maps\example\funcspawn.bsp - func_spawn demonstration
  85. fakk\maps\example\gibs_and_health.bsp - gibs and health demonstration
  86. fakk\maps\example\letterbox.bsp - letterbox demonstration
  87. fakk\maps\example\multiexploder.bsp - multi-exploder demonstration
  88. fakk\maps\example\patrol.bsp    - AI Patrol demonstration
  89. fakk\maps\example\pickup.bsp    - Picking up Shgliek demonstration
  90. fakk\maps\example\pushobject.bsp - Push Object demonstration
  91. fakk\maps\example\rain.bsp      - Rain and Leaves demonstration
  92. fakk\maps\example\runthrough.bsp - func_runthrough demonstartion
  93. fakk\maps\example\scriptgravity.bsp - Script gravity demonstration
  94. fakk\maps\example\sinkobject.bsp - Sink Object demonstration
  95. fakk\maps\example\teleporter.bsp - Teleporter demonstration
  96. fakk\maps\example\useanim.bsp   - UseAnim demonstration
  97. fakk\maps\example\useobject.bsp - UseObject demonstration
  98. fakk\maps\example\vehicle.bsp   - Vehicle demonstration
  99. fakk\maps\example\zoo.bsp       - Zoo map
  100.  
  101. fakk\scripts\fakk.qe4           - Q3Radiant setup file
  102. fakk\scripts\surfacelist.txt    - list of all textures with surface defs
  103.  
  104. source\source\cgame             - FAKK 2 CGame source
  105.  
  106. source\source\fgame             - FAKK 2 Game source
  107.  
  108. source\source\qcommon           - common files needed for above
  109. source\source\win32             - common files needed for above
  110.  
  111. source\utils\common             - common source files for utilities
  112. source\utils\dlgedit            - source for resource editor
  113. source\utils\fontgen            - source for font generator
  114. source\utils\ftxconvert         - source for FTX converter
  115. source\utils\lipsync            - source for LIPSYNC tool
  116. source\utils\lw2tan             - source for Lightwave converter
  117. source\utils\max2plugins        - source for MAX 2 plugins
  118. source\utils\max2skl            - source for MAX skeletal converter
  119. source\utils\max2tan            - source for MAX vertex animation converter
  120. source\utils\max3plugins        - source for MAX 3 plugins
  121. source\utils\tgaconvert         - source for TGA converter
  122.  
  123. You will need to download the 3D Studio MAX SDK in order to rebuild the
  124. plugins.  The lipsync converter does not include the header or library from
  125. Miles since that is not re-distributable.
  126.  
  127. Thank you and good luck,
  128.  
  129. Scott Alden, Mark Dochtermann and Steven Peeler
  130.  
  131. The FAKK 2 Programming Team
  132.  
  133. ---------------------------------------------------------------
  134.  
  135. INSTALLATION:
  136.  
  137. The tools ships with almost no game data.  As a result you will have to unpack
  138. pak0.pk3, pak1.pk3 and pak2.pk3 in order to start building maps for the game.
  139. You will need about 750 MB free on your hard drive to unpack these files.  To do
  140. this, drop the PK3 files on zip extraction utility like WinZip and unpack the
  141. paks with the Folder Names option checked into the "fakk" directory of this
  142. install. Once you have unpacked the pak files, the editor and tools will be
  143. able to access them freely.
  144.  
  145. In order to build maps directly from q3radiant you will need to make sure that
  146. the file fakk.qe4 in fakk/scripts is setup properly.  The file has been
  147. configured for an installation in the c:\fakktools\ directory if this is not
  148. the directory you installed the tools into, you will need to edit the fakk.qe4
  149. file.
  150.  
  151. To run the editor, run runq3radiant.bat in the bin directory or you can
  152. create a shortcut on your desktop by leftclick-dragging q3radiant.exe on
  153. your desktop. Go the properties tab and add the following to the command line
  154. (Target field):
  155.  
  156. q3radiant.exe ..\fakk\scripts\fakk.qe4
  157.  
  158. LINKS:
  159.  
  160. www.gith.net - Heavy Metal FAKK 2 editing site
  161. www.fakkyou.com - Heavy Metal FAKK 2 page
  162.  
  163. www.ritual.com - Ritual Entertainment's Home Page
  164. www.ritualistic.com - #1 resource for Ritual related news
  165. www.heavymetal.net - Official Heavy Metal site for Heavy Metal Magazine
  166.